home *** CD-ROM | disk | FTP | other *** search
/ System Booster / System Booster.iso / Commodities / NewShell / NewShellCX.doc < prev    next >
Text File  |  1996-09-26  |  10KB  |  237 lines
  1.  
  2.                               NewShellCX
  3.  
  4.                              (Commodity)
  5.  
  6.                                   by
  7.  
  8.                             Stefan Sticht
  9.  
  10.          This program (binary), sourcecode, documentation is 
  11.  
  12.                             PUBLIC DOMAIN.
  13.  
  14.                      You may do anything with it!
  15.  
  16.  
  17. Purpose of this commodity:
  18. --------------------------
  19. NewShellCX  allows  you to open a new shell by just pressing a hotkey.
  20. The hotkey and the command, which will be executed can be specified.
  21.  
  22.  
  23. Requirements:
  24. -------------
  25. This commodity requires at least Kickstart 37.#?  and Workbench 37.#?.
  26. Please  check  this  out  using Version in the Shell or About from the
  27. Workbench's   Workbench   menu.    You   also   need   to   have   the
  28. commodities.library  in your libs:  directory.
  29.  
  30.  
  31. How to start a commodity:
  32. -------------------------
  33. First  there  are  two  basically different ways to start a commodity:
  34. via Workbench or via Shell.
  35.  
  36.     Starting  it  via Workbench is extrem simple:  just doubleclick on
  37. its  icon  and  the  commodity gets started.  Perhaps you might change
  38. some  parameters of the commodity.  You do this with tool types.  Tool
  39. types can be changed by clicking at the commodities icon and selecting
  40. Information from the Workbench's Icon menu.  In the window which opens
  41. you  see a listview gadget in which all tool types are listed.  Please
  42. refer  to  your  Workbench  documentation  on  how to change this tool
  43. types.  Which parameters you can change for this specific commodity is
  44. described below.
  45.     Please  note  that  another  double  click on the commodity's icon
  46. forces  the  commodity  to quit, if it's already running.  Running two
  47. copies  of  NewShellCX  at  the  same  time isn't useful and therefore
  48. possible.
  49.     To  start  a commodity via shell you type in its name.  If you get
  50. an  "Unknown  command  ???"  error  message,  you  have misspelled the
  51. commodity's  name  or the commodity isn't in your current directory or
  52. in the current search path.  The easiest way is to change your current
  53. directory  to the location of the commodity using the CD command.  You
  54. can  change  parameters  of  a commodity by command line options.  The
  55. available options are listed with ?  as the first parameter:
  56.  
  57.                              NewShellCX ?
  58.  
  59. gives you a list of the command line options.  The explanation of each
  60. option is below.  Starting the commodity once more while it is already
  61. running forces the commodity to quit.
  62.  
  63.     If  you  want  the  commodity to be started at every boot-up, it's
  64. best to add this line to your User-Startup file:
  65.  
  66.                  Run >NIL: <path>NewShellCX <options>
  67.  
  68. Don't  forget  to  replace  <path>  by  the  path to the commodities's
  69. location  and <options> by the options you want to change. For example
  70. add this line if your commodity is located in the Tools drawer of your
  71. boot disk:
  72.  
  73.                       Run >NIL: Tools/NewShellCX
  74.  
  75.     Another way to start the commodity at every boot-up is to drag its
  76. icon  in  the  WBStartup drawer of your boot disk.  Then the commodity
  77. gets  started  as if you had double clicked on its icon.  But you have
  78. to  add the tool type DONOTWAIT to the icon.
  79.  
  80. This is the common way to start any commodity.  Starting NewShellCX to
  81. spawn  a  new  shell is bit more complicated.  If you start NewShellCX
  82. from Workbench (or from the WBStartup-drawer), a opened shell will not
  83. inherit   the   path   specified   in   the   startup-sequence  and/or
  84. User-Startup.   If  you  do  not  want  to  update  your  path  in the
  85. Shell-Startup  file  using an explicit Path command, the only solution
  86. is  to  start  NewShellCX  in your User-Startup file after setting the
  87. path.   If  do  not change the path in your User-Startup file, you may
  88. start NewShellCX anywhere in User-Startup.
  89.  
  90.  
  91. Using Exchange:
  92. ---------------
  93. Exchange is the commodities controller program. With Exchange you can
  94. control all commodities: you can kill, disable, enable, show and hide
  95. commodities.
  96.     Start  the  Exchange  program,  which  usually is in the Utilities
  97. drawer  of your boot disk, by double clicking its icon.  Now you see a
  98. list  of  the available commodities.  Select the commodity you want to
  99. control.   The  commodities title, description and status is shown now
  100. below the listview gadget.
  101.     You  can  kill  the  commodity  using  the  Kill gadget...  If the
  102. commodity  has  a  window  to  open,  in which you usually change some
  103. parameters,  you  can  open  this window using Show.  Hide closes this
  104. window. NewShellCX has no window, which can be opened.
  105.  
  106.  
  107.                         Changeable parameters:
  108.                         ----------------------
  109.  
  110. CX_Priority:
  111. ------------
  112. You  can  specify the priority of the Commodity within the commodities
  113. queue  using the tool type or commandline option CX_PRIORITY=<number>,
  114. where  <number>  is  the  decimal  value  for  the  priority.  Default
  115. priority is 0.
  116.  
  117. HOTKEY:
  118. -------
  119. With  the  tool type or commandline option HOTKEY=<string> you specify
  120. the key, which executes the command.  <string> is an input description
  121. string  as  explained  below.   Default is "HOTKEY=lcommand esc" (left
  122. Amiga key & ESC key).
  123.  
  124. Examples:
  125.  
  126.     NewShellCX "hotkey=ralt help"
  127.     NewShellCX "hotkey=lcommand m"
  128.     NewShellCX "hotkey=f1"
  129.  
  130. COMMAND:
  131. --------
  132. With  the  tool  type or commandline option COMMAND=<file> you specify
  133. the  command,  which  you want to be executed.  <file> is the path and
  134. name  of the command plus additional parameters, just as if you'd type
  135. this  line at a shell.  Default is COMMAND=NewShell, which spans a new
  136. shell.
  137.  
  138. Examples:
  139. NewShellCX "Command=NewShell CON:0/0/640/200/MyShell/CLOSE FROM s:Shell-Startup"
  140. NewShellCX "Command=c:NewWSH"
  141. NewShellCX "Command=Tools:ClickDOS_II"
  142.  
  143. PUBLICSCREEN:
  144. -------------
  145. With  the  option  PUBLICSCREEN=<string> you can specify the name of a
  146. public  screen,  which  will  be  switched  to  front if you press the
  147. hotkey.   E.g.   "PUBLICSCREEN=Workbench" pops the Workbench screen to
  148. front.   "PUBLICSCREEN=DEFAULT"  puts  the  default  public  screen to
  149. front.  "PUBLICSCREEN=" (default) disables this option.
  150.  
  151. MOVEABSOLUTE:
  152. -------------
  153. With  the  next to options MOVEX and MOVEY you can secify a horizontal
  154. and  a vertical value.  MOVEABSOLTE determines, if these values should
  155. be interpreted as relative or absolute values.  MOVEABSOLUTE=YES means,
  156. the  values  are  absolute and the upper lefthand corner of the screen
  157. specified  with PUBLICSCREEN should be moved to the position specified
  158. by the values.  MOVEABSOLUTE=NO means the values should be interpreted
  159. as values relative to the current position of the screen.
  160.  
  161. MOVEX:
  162. ------
  163. With  MOVEX=<number> you specify the horizontal position, to which the
  164. screen  should be moved depending on MOVEABSOLUTE.  <number> should be
  165. a decimal value.
  166.  
  167. MOVEY:
  168. ------
  169. With  MOVEY=<number>  you  specify the vertikal position, analogous to
  170. MOVEX.
  171.  
  172.  
  173.                       Input description strings
  174.                       -------------------------
  175.  
  176. With  input  description  strings  you  can  specify  almost any input
  177. action,  for  example  the action lshift f1, which means that pressing
  178. the  left  shift  and  the  f1  key  together  is the action.  In this
  179. commodity  you  can specify the action to open the commodity's window,
  180. as described above.
  181.  
  182. Input description strings have the following template:
  183.  
  184.       [class] (([-]qual)|syn)* [[-]upstroke] [highmap|ANSIcode]
  185.  
  186. (* means zero or more occurances of the of the expression in brackets)
  187.  
  188. class   is one of the following strings:
  189.         rawkey, rawmouse, event, pointerpos, timer, newprefs,
  190.         diskremoved, diskinserted.
  191.         If not specified, the class is taken to be "rawkey".
  192.  
  193. qual    is one of the strings:
  194.         lshift, rshift, capslock, control, lalt, ralt, lcommand,
  195.         rcommand, numericpad, repeat, midbutton, rbutton, leftbutton,
  196.         relativemouse
  197.         A preceding '-' means that the value of the corresponding
  198.         qualifier is to be considered irrelevant.
  199.  
  200. syn     (synonym) is one of the strings: shift, caps, alt
  201.         shift means "left or right shift"
  202.         caps means "shift or capslock"
  203.         alt means "either alt key"
  204.  
  205. upstroke (literally "upstroke")
  206.         if this token is absent, only downstrokes are considered
  207.         for rawmouse (mousebuttons) and rawkey events.  If it is
  208.         present alone, only upstrokes count.  If it preceded by
  209.         '-' it means that both up and down strokes are included.
  210.  
  211. highmap one of the strings:
  212.         comma, space, backspace, tab, enter, return, esc, del, up,
  213.         down, right, left, help, f1, f2, f3, f4, f5, f6, f7, f8, f9,
  214.         f10, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, (, ), /, *, -, +
  215.  
  216. ansicode a single character token is interpreted as a character code,
  217.         which is looked up in the system default keymap.
  218.  
  219.  
  220.    Send bug-reports, enhancement-requests, questions, gifts(!) to:
  221.    ---------------------------------------------------------------
  222.                             Stefan Sticht
  223.                           Bibereckerweg 40a
  224.                            D-8390 Passau 18
  225.                                  FRG
  226.  
  227. or (better) EMail to:
  228. cbmvax.commodore.com!cbmehq!cbmger!danube!edith!sticht [prefered!]
  229. or sticht%edith@danube.deg.sub.org
  230. or sticht@eva.uni-passau.de
  231. or IWSTICHT@ibm.rz.uni-passau.de
  232. Fido-Net: Stefan Sticht (2:242/77:4)
  233.  
  234. Please include the version number of the commodity in every bug report.
  235. You  get  the  version  number  using  the  Version  command:
  236.                      Version [<path>]<commodity>
  237.